API Documentation
Public Member Functions | List of all members
nkGraphics::RenderScenePass Class Reference

A pass rendering render queues. More...

Inheritance diagram for nkGraphics::RenderScenePass:
nkGraphics::Pass nkGraphics::ProfilableClass nkExport::Exportable nkGraphics::MonoMaterialPass

Public Member Functions

int getMinRQ () const
 
int getMaxRQ () const
 
RenderQueuegetSpecialRQ () const
 
CameragetRenderCam () const
 
CameragetCullingCam () const
 
CameragetLodCam () const
 
BlendStategetBlendState () const
 
RasterStategetRasterState () const
 
DepthStencilStategetDepthStencilState () const
 
bool isTransparentPass () const
 
void setMinRQ (int value)
 
void setMaxRQ (int value)
 
void setSpecialRQ (const char *name)
 
void setRenderCam (Camera *cam)
 
void setCullingCam (Camera *cam)
 
void setLodCam (Camera *cam)
 
virtual void setBlendState (BlendState *state)
 
virtual void setRasterState (RasterState *state)
 
virtual void setDepthStencilState (DepthStencilState *state)
 
void setTransparentPass (bool value)
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkGraphics::Pass
TargetOperationsgetParentTargetOperations () const
 
PASS_TYPE getPassType () const
 
const char * getName () const
 
void setParentTargetOperations (TargetOperations *parent)
 
void setName (const char *name)
 
virtual void render ()=0
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A pass rendering render queues.

It uses the meshes within the queues, each having potentially a different shader set using the their Entity.
See TargetOperations::addRenderScenePass() for use.

Member Function Documentation

◆ getMinRQ()

int nkGraphics::RenderScenePass::getMinRQ ( ) const
Returns
The minimum indexed render queue rendered.

◆ getMaxRQ()

int nkGraphics::RenderScenePass::getMaxRQ ( ) const
Returns
The maximum indexed render queue rendered.

◆ getSpecialRQ()

RenderQueue* nkGraphics::RenderScenePass::getSpecialRQ ( ) const
Returns
The special (named) render queue rendered.

◆ getRenderCam()

Camera* nkGraphics::RenderScenePass::getRenderCam ( ) const
Returns
The rendering cam used for the pass.

◆ getCullingCam()

Camera* nkGraphics::RenderScenePass::getCullingCam ( ) const
Returns
The culling camera used for the pass.

◆ getLodCam()

Camera* nkGraphics::RenderScenePass::getLodCam ( ) const
Returns
The LOD camera used for the pass.

◆ getBlendState()

BlendState* nkGraphics::RenderScenePass::getBlendState ( ) const
Returns
The blend state used for the pass.

◆ getRasterState()

RasterState* nkGraphics::RenderScenePass::getRasterState ( ) const
Returns
The raster state used for the pass.

◆ getDepthStencilState()

DepthStencilState* nkGraphics::RenderScenePass::getDepthStencilState ( ) const
Returns
The depth and stencil state used for the pass.

◆ isTransparentPass()

bool nkGraphics::RenderScenePass::isTransparentPass ( ) const
Returns
Whether the pass considers transparent rendering (true) or not (false).

◆ setMinRQ()

void nkGraphics::RenderScenePass::setMinRQ ( int  value)

Sets the minimum index of the render queues rendered. By default, it is -1, which means all queues.

Parameters
valueThe index for the boundary.

◆ setMaxRQ()

void nkGraphics::RenderScenePass::setMaxRQ ( int  value)

Sets the maximum index of the render queues rendered. By default, it is -1, which means all queues.

Parameters
valueThe index of the boundary.

◆ setSpecialRQ()

void nkGraphics::RenderScenePass::setSpecialRQ ( const char *  name)

Sets the special (named) render queue to render.

Parameters
nameThe name of the queue to render.

◆ setRenderCam()

void nkGraphics::RenderScenePass::setRenderCam ( Camera cam)

Sets the render camera used for the pass.

Parameters
camThe camera to use.

◆ setCullingCam()

void nkGraphics::RenderScenePass::setCullingCam ( Camera cam)

Sets the culling camera used for the pass.

Parameters
camThe camera to use.

◆ setLodCam()

void nkGraphics::RenderScenePass::setLodCam ( Camera cam)

Sets the LOD camera used for the pass.

Parameters
camThe camera to use.

◆ setBlendState()

virtual void nkGraphics::RenderScenePass::setBlendState ( BlendState state)
virtual

Sets the blend state to use for the pass.

Parameters
stateThe state to use.

◆ setRasterState()

virtual void nkGraphics::RenderScenePass::setRasterState ( RasterState state)
virtual

Sets the raster state to use for the pass.

Parameters
stateThe state to use.

◆ setDepthStencilState()

virtual void nkGraphics::RenderScenePass::setDepthStencilState ( DepthStencilState state)
virtual

Sets the depth and stencil state to use for the pass.

Parameters
stateThe state to use.

◆ setTransparentPass()

void nkGraphics::RenderScenePass::setTransparentPass ( bool  value)

Sets whether the pass should consider transparent rendering. Off by default.
Consider leaving it off whenever possible; when rendering transparent meshes rendering cannot be as performant.

Parameters
valueIf transparent meshes will be rendered (true) or not (false).

◆ exportClassToTree()

virtual void nkGraphics::RenderScenePass::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Reimplemented from nkGraphics::Pass.

Reimplemented in nkGraphics::MonoMaterialPass.

◆ importClassFromTree()

virtual void nkGraphics::RenderScenePass::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Reimplemented from nkGraphics::Pass.

Reimplemented in nkGraphics::MonoMaterialPass.


The documentation for this class was generated from the following file: